Skip to content

add exponential search algorithm #10732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Oct 21, 2023
Merged

Conversation

kiarash8112
Copy link
Contributor

Describe your change:

added exponential algorithm using binary_search_recursion also tests and docs about it

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 20, 2023
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed tests are failing Do not merge until tests pass labels Oct 20, 2023
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition!

For optional extra credit, add a timeit benchmark to show relative performance.

@@ -297,6 +297,49 @@ def binary_search_by_recursion(
return binary_search_by_recursion(sorted_collection, item, midpoint + 1, right)


def exponential_search(sorted_collection: list[int], item: int) -> int | None:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not a fan of functions that return multiple datatypes. If the search fails, let's return -1 (like "Hello".find("Z")) or raise a ValueError (like "Hello".index("Z")).

Suggested change
def exponential_search(sorted_collection: list[int], item: int) -> int | None:
def exponential_search(sorted_collection: list[int], item: int) -> int:

@algorithms-keeper algorithms-keeper bot added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Oct 21, 2023
@cclauss cclauss self-assigned this Oct 21, 2023
Co-authored-by: Christian Clauss <[email protected]>
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed awaiting changes A maintainer has requested changes to this PR labels Oct 21, 2023
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 21, 2023
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 21, 2023
@cclauss
Copy link
Member

cclauss commented Oct 21, 2023

I thought more about sorting the sorted collection… it is a bad idea. The second item in might be different in the two lists so the function might tell me that is the second item when in my list it is the third item. So, the implementations should raise ValueError on unsorted input.

@kiarash8112 kiarash8112 requested a review from cclauss October 21, 2023 08:44
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a really slick addition. Thanks for doing it!

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 21, 2023
@cclauss cclauss merged commit b814cf3 into TheAlgorithms:master Oct 21, 2023
@kiarash8112
Copy link
Contributor Author

@cclauss thank you for your suggestions :)

@tianyizheng02
Copy link
Contributor

@cclauss Since exponential search is a different algorithm from binary search, why was it placed in the binary_search.py file? Shouldn't it have gotten its own file?

bound *= 2
left = bound // 2
right = min(bound, len(sorted_collection) - 1)
last_result = binary_search_by_recursion(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tianyizheng02 exponential_search() embeds a call to binary_search_by_recursion() but as the benchmarks demonstrate delivers a faster result. Looking at the first commit makes this clearer.

sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
* add exponential_search algorithm

* replace binary_search with binary_search_recursion

* convert left type to int to be useable in binary_search_recursion

* add docs and tests for exponential_search algorithm

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* move exponential_search to binary_search.py to pass github auto build tests

delete exponential_search.py file

* Update searches/binary_search.py

Co-authored-by: Christian Clauss <[email protected]>

* remove additional space  searches/binary_search.py

Co-authored-by: Christian Clauss <[email protected]>

* return single data type in exponential_search searches/binary_search.py

Co-authored-by: Christian Clauss <[email protected]>

* add doctest mod searches/binary_search.py

Co-authored-by: Christian Clauss <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* use // instread of int() convert  searches/binary_search.py

Co-authored-by: Christian Clauss <[email protected]>

* change test according to new code searches/binary_search.py

Co-authored-by: Christian Clauss <[email protected]>

* fix binary_search_recursion multiple type return error

* add a timeit benchmark for exponential_search

* sort input of binary search to be equal in performance test with exponential_search

* raise value error instead of sorting input in binary and exonential search to fix bugs

* Update binary_search.py

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <[email protected]>
Co-authored-by: user <[email protected]>
@isidroas isidroas mentioned this pull request Jan 25, 2025
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants